home *** CD-ROM | disk | FTP | other *** search
/ Risc World 3 / Risc World 3.iso / SOFTWARE / ISSUE4 / ZAP / !Zap / Modules / !ForZap / !Help next >
Text File  |  2002-09-18  |  6KB  |  199 lines
  1.  
  2.    ForZap - A syntax colouring mode for Zap's internal configuration files
  3.    =======================================================================
  4.  
  5. Contents
  6. ========
  7.  
  8. 1.0 : Features.
  9. 2.0 : Installation.
  10. 3.0 : What it does.
  11. 4.0 : Problems.
  12. 5.0 : Early history.
  13. 6.0 : Contact.
  14.  
  15.  
  16. 1.0 : Features
  17. ==============
  18.  
  19. Syntax colouring of the Keys, External and HelpData files.
  20. There is also some support for Justin Fletcher's Zap scripts.
  21.  
  22.  
  23. 2.0 : Installation
  24. ==================
  25.  
  26. Copy !ForZap into Zap's Modules directory.
  27.  
  28. Zap will then need to be restarted.
  29.  
  30.  
  31. 3.0 : What it does and does not do
  32. ==================================
  33.  
  34. It syntax-colours files of Zap commands.
  35.  
  36. The various files it tries to colour are in a number of different formats
  37. and the colouring used is a bit of a compromise solution that looks quite
  38. good with all the files.  The mode auto-detects whether the keys file is
  39. being edited and adjusts its colouring accordingly.
  40.  
  41. The mode offers command completion, bracket matching and all the usual
  42. widgets.
  43.  
  44. As Zap commands are not case sensitive, an option to allow for this has been
  45. added, but trying to use the module without the case sensitivity turned on
  46. causes it to highlight numerous innocent words which also happen to be Zap
  47. commands.
  48.  
  49. The author has case sensitivity turned on.  Case sensitivity only applies to
  50. those Zap commands which may easily be taken for normal English words.
  51. Even with case sensitivity turned on, most commands are still recognised in
  52. either case, but words like "IF" and "MODE" must be in upper case for them
  53. to be coloured as Zap commands.  The author has edited his 'Keys' file so all
  54. the Zap commands in it are in upper case.
  55.  
  56. The Keys file (or any other files with "KEY" in the first 256 bytes of the
  57. text) is treated slightly differently from other files.  In particular,
  58. Words starting on the first line are never coloured as keywords.
  59.  
  60. If the command list looks out of date, either file a bug report
  61. (bugs@zap.tartarus.org) or fix it yourself - the list is stored at the end of
  62. the file, and you can add to it yourself without breaking things. Each entry
  63. is of the form:
  64.  
  65.  [#]<command> [|,°,«,}]
  66.  
  67. where the # is optional, and means 'case sensitive' and the other characters
  68. mean:
  69.  
  70.  | - normal
  71.  ° - don't colour (but still complete, etc.)
  72.  « - directive
  73.  } - something to do with JRF scripting?
  74.  
  75. Note that, even if you edit your own copy, we'd rather you file a bug report
  76. so we know about it too :-)
  77.  
  78. 4.0 : Problems
  79. ==============
  80. * The case sensitivity is a problem.
  81. * In the Keys file, ( ... ) sequences containing TAB characters are not
  82.   coloured.
  83.  
  84.  
  85. 5.0 : Early history
  86. ===================
  87.  
  88. v0.26 - (13-Sep-02)
  89. v0.25 - (18-Jan-02)
  90.       * Some new commands added
  91.  
  92. v0.24 - (29-Nov-01)
  93.       * TEXTURE_FLAGSTOGGLE added
  94.  
  95. v0.23 - (06-Jul-01)
  96.       * Bugfix to Scripts loading code.
  97.  
  98. v0.22 - (30-Jun-2001) [cl]
  99.       * Fix for bug causing data aborts in new files
  100.       * Dummy command "Yum" no longer auto completes
  101.  
  102. v0.21 - (05-Nov-2000)
  103. v0.20 - (08-May-2000)
  104. v0.19 - (20-Mar-2000)
  105. v0.18 - (28-Feb-2000)
  106. v0.17 - (24-Nov-1999)
  107. v0.16 - (28-Sep-1999)
  108. v0.15 - (25-Jun-1997)
  109.       * A number of new commands added.
  110.  
  111. v0.14 - (18-Apr-1997)
  112.       * An RPC start-of-file bug fixed.
  113.       * A number of new commands added.
  114.  
  115. v0.13 - (03-Apr-1997)
  116.       * RUNSCRIPT and INSERT file commands added (and a few others).
  117.       * Pressing escape at the same time as pressing '.' now always produces
  118.         a '.' and never completes commands.
  119.  
  120. v0.12 - (28-Mar-1997)
  121.       * Support of files of commands for Olly Betts' LineEditor added.
  122.         This only really works well if the commands are all in upper case.
  123.       * In 'Keys-like' files, numbers in the first column are not coloured.
  124.  
  125. v0.11 - (21-Mar-1997)
  126.       * Syntax-colouring of Justin Fletcher's script files' directives.
  127.       * A few new commands added.
  128.  
  129. v0.10 - (18-Mar-1997)
  130.       * Now detects whether the file is a "Keys" file (by searching for
  131.         "KEY" in the first 256 bytes of the file).  If so then ( ... )
  132.         sequences are coloured, "|"s are ignored and the quote character is
  133.         ignored if it is at the start of a line.  Any commands at the very
  134.         beginnings of lines are not highlighted as they normally would be.
  135.         If the keys file detection fails for some reason it is possible to
  136.         control it manually from the mode menu.
  137.  
  138. v0.09 - (14-Mar-1997)
  139.       * More commands added.
  140.       * Beautify now works on the first character of names properly
  141.         (introduced in v0.08).
  142.       * 'FORZAP_FLAGSTOGGLE' command and buttons menu added.
  143.  
  144. v0.08 - (27-Feb-1997)
  145.       * Added support for the latest version of ZapEmail.
  146.       * Cured bugs relating to <...> sequences being coloured incorrectly
  147.         when editing them.
  148.       * Commands starting on the first character of the file are now coloured
  149.         correctly.
  150.  
  151. v0.07 - (26-Feb-1997)
  152.       * Buttons support added.
  153.  
  154. v0.06 - (23-Feb-1997)
  155.       * Case sensitivity is now confined to problematical words - most
  156.         command recognition is now case insensitive.
  157.       * Many new commands added.
  158.       * Delimiters of ( ... ) sequences are now coloured the same as their
  159.         contents.
  160.  
  161. v0.05 - (21-Feb-1997)
  162.       * The option to turn case sensitivity off was not working.
  163.       * A few commands added.
  164.  
  165. v0.04 - (18-Feb-1997)
  166.       * A " on the first character of a line (as may occur in the keys file)
  167.         is now ignored.
  168.       * Priorities of ( ... ) checking and command checking at line ends
  169.         corrected.
  170.       * Configuration saving routines should now work properly without
  171.         interfering with other modes.
  172.  
  173. v0.03 - (17-Feb-1997)
  174.       * A few commands added and the paths checked for corrected.
  175.  
  176. v0.02 - (13-Feb-1997) 
  177.       * Added the option to turn case sensitivity off.
  178.  
  179. v0.01 - (12-Feb-1997) 
  180.       * First released version.
  181.  
  182.  
  183. 6.0 : Contact
  184. =============
  185.  
  186.   Any bug reports or missing commands should be sent to 
  187.   
  188.         bugs@zap.tartarus.org
  189.         
  190.   Feature requests should be directed towards
  191.   
  192.           zap-features@zap.tartarus.org
  193.  
  194.  
  195. There are a also a number of mailing lists you can subscribe to - see
  196. Zap's web pages for details:
  197.  
  198.         http://zap.tartarus.org/
  199.